[BC]SecurityInsights Module Breaking Changes Announcement Date Update#29133
Conversation
| Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status. |
There was a problem hiding this comment.
Pull request overview
This PR updates the breaking change announcement dates for the SecurityInsights module from Az v15.0.0 (November 19th 2025) to Az v16.0.0 (May 2025/2026). The changes include updates to preview messages, breaking change effective dates, assembly version, module manifest metadata, and various documentation examples.
Changes:
- Updated breaking change announcement from Az v15.0.0 to Az v16.0.0
- Changed assembly version from 3.2.0 to 3.2.1
- Updated various GUIDs in solution and documentation files
- Modified help documentation examples with updated GUIDs and minor text changes
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| src/SecurityInsights/SecurityInsights/help/New-AzSentinelIncidentTeam.md | Updated example output with different tenant GUID |
| src/SecurityInsights/SecurityInsights/help/New-AzSentinelAlertRule.md | Modified example with spelling changes and removed parameter |
| src/SecurityInsights/SecurityInsights/help/Get-AzSentinelEntityInsight.md | Updated example with different entity GUID |
| src/SecurityInsights/SecurityInsights/help/Get-AzSentinelEntityActivity.md | Changed description text with spelling error |
| src/SecurityInsights/SecurityInsights/help/Get-AzSentinelEntity.md | Updated variable names in example |
| src/SecurityInsights/SecurityInsights/Az.SecurityInsights.psd1 | Updated generation date, Az.Accounts version requirement, and formatting |
| src/SecurityInsights/SecurityInsights.sln | Updated project GUID reference |
| src/SecurityInsights/SecurityInsights.Autorest/generate-info.json | Updated generation GUID |
| src/SecurityInsights/SecurityInsights.Autorest/docs/Az.SecurityInsights.md | Updated module GUID |
| src/SecurityInsights/SecurityInsights.Autorest/README.md | Updated breaking change dates and preview messages from v15.0.0 to v16.0.0 |
| src/SecurityInsights/SecurityInsights.Autorest/Properties/AssemblyInfo.cs | Incremented version from 3.2.0 to 3.2.1 |
| ### Example 5: Create a Scheduled Alert Rule | ||
| ```powershell | ||
| New-AzSentinelAlertRule -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -Kind Scheduled -Enabled -DisplayName "Powershell Execution Alert (Several Times per Hour)" -Severity Low -Query "SecurityEvent | where EventID == 4688" -QueryFrequency (New-TimeSpan -Hours 1) -QueryPeriod (New-TimeSpan -Hours 1) -TriggerThreshold 10 -TriggerOperator "GreaterThan" | ||
| New-AzSentinelAlertRule -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -Kind Scheduled -Enabled -DisplayName "Powershell Exection Alert (Several Times per Hour)" -Severity Low -Query "SecurityEvent | where EventId == 4688" -QueryFrequency (New-TimeSpan -Hours 1) -QueryPeriod (New-TimeSpan -Hours 1) -TriggerThreshold 10 |
There was a problem hiding this comment.
The query was changed from "EventID == 4688" to "EventId == 4688". This change in casing could potentially affect the query's functionality depending on whether the underlying schema uses case-sensitive field names. Please verify that "EventId" is the correct field name in the SecurityEvent table schema.
| deprecated-by-azversion: 15.0.0 | ||
| change-effective-date: 2025/11/19 | ||
| deprecated-by-azversion: 16.0.0 | ||
| change-effective-date: 2025/05 |
There was a problem hiding this comment.
Inconsistent breaking change effective dates within the same file. Line 366 specifies "2025/05" while line 375 specifies "2026/05". These should be consistent and aligned with the same breaking change announcement for Az v16.0.0.
| ### Example 5: Create a Scheduled Alert Rule | ||
| ```powershell | ||
| New-AzSentinelAlertRule -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -Kind Scheduled -Enabled -DisplayName "Powershell Execution Alert (Several Times per Hour)" -Severity Low -Query "SecurityEvent | where EventID == 4688" -QueryFrequency (New-TimeSpan -Hours 1) -QueryPeriod (New-TimeSpan -Hours 1) -TriggerThreshold 10 -TriggerOperator "GreaterThan" | ||
| New-AzSentinelAlertRule -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -Kind Scheduled -Enabled -DisplayName "Powershell Exection Alert (Several Times per Hour)" -Severity Low -Query "SecurityEvent | where EventId == 4688" -QueryFrequency (New-TimeSpan -Hours 1) -QueryPeriod (New-TimeSpan -Hours 1) -TriggerThreshold 10 |
There was a problem hiding this comment.
Spelling error in the example command. "Exection" should be "Execution" in the DisplayName parameter value.
| ``` | ||
|
|
||
| This command gets insights and activities for an Entity by object | ||
| This command gets insights and activies for an Entity by object |
There was a problem hiding this comment.
Spelling error in the example description. "activies" should be "activities".
| This command gets insights and activies for an Entity by object | |
| This command gets insights and activities for an Entity by object |
| $Entitys = Get-AzSentinelEntity -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" | ||
| $Entitys[0] | Get-AzSentinelEntity |
There was a problem hiding this comment.
Variable naming inconsistency. The variable is changed from "Entities" to "Entitys", but "Entitys" is not grammatically correct. The plural of "Entity" should be "Entities".
| $Entitys = Get-AzSentinelEntity -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" | |
| $Entitys[0] | Get-AzSentinelEntity | |
| $Entities = Get-AzSentinelEntity -ResourceGroupName "myResourceGroupName" -workspaceName "myWorkspaceName" | |
| $Entities[0] | Get-AzSentinelEntity |
| ### Example 5: Create a Scheduled Alert Rule | ||
| ```powershell | ||
| New-AzSentinelAlertRule -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -Kind Scheduled -Enabled -DisplayName "Powershell Execution Alert (Several Times per Hour)" -Severity Low -Query "SecurityEvent | where EventID == 4688" -QueryFrequency (New-TimeSpan -Hours 1) -QueryPeriod (New-TimeSpan -Hours 1) -TriggerThreshold 10 -TriggerOperator "GreaterThan" | ||
| New-AzSentinelAlertRule -ResourceGroupName "myResourceGroup" -WorkspaceName "myWorkspaceName" -Kind Scheduled -Enabled -DisplayName "Powershell Exection Alert (Several Times per Hour)" -Severity Low -Query "SecurityEvent | where EventId == 4688" -QueryFrequency (New-TimeSpan -Hours 1) -QueryPeriod (New-TimeSpan -Hours 1) -TriggerThreshold 10 |
There was a problem hiding this comment.
The TriggerOperator parameter was removed from this example, but according to line 654 in this same file, TriggerOperator is a required parameter for the Scheduled parameter set. Removing it will make this example non-functional. The parameter should be retained in the example.
| --> | ||
|
|
||
| ## Upcoming Release | ||
| * Update preannouncement breaking changes date to May 2026. |
| set: | ||
| preview-announcement: | ||
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v15.0.0, to be released on November 19th 2025. *\\r\\n* At least one change applies to this cmdlet. *\\r\\n* See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *\\r\\n**************************************************************************************************" | ||
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2025. *\\r\\n* At least one change applies to this cmdlet. *\\r\\n* See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *\\r\\n**************************************************************************************************" |
| set: | ||
| preview-announcement: | ||
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v15.0.0, to be released on November 19th 2025. *\\r\\n* At least one change applies to this cmdlet. *\\r\\n* See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *\\r\\n**************************************************************************************************" | ||
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2025. *\\r\\n* At least one change applies to this cmdlet. *\\r\\n* See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *\\r\\n**************************************************************************************************" |
| breaking-change: | ||
| deprecated-by-version: 4.0.0 | ||
| deprecated-by-azversion: 15.0.0 | ||
| change-effective-date: 2025/11/19 | ||
| deprecated-by-azversion: 16.0.0 | ||
| change-effective-date: 2025/05 |
| --- | ||
| Module Name: Az.SecurityInsights | ||
| Module Guid: a632df01-f50e-49fb-b2de-e91a0090c840 | ||
| Module Guid: 8e31f664-41a6-46c6-ba93-5fc34733ec88 |
| --> | ||
|
|
||
| ## Upcoming Release | ||
| * Updated preannouncement breaking changes date to May 2026. |
There was a problem hiding this comment.
The changelog entry uses “preannouncement”, but the existing entry below uses “Preannounced”. Please update this wording for consistency and correct grammar (e.g., “preannounced breaking changes date”).
| * Updated preannouncement breaking changes date to May 2026. | |
| * Updated preannounced breaking changes date to May 2026. |
| preview-announcement: | ||
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v15.0.0, to be released on November 19th 2025. *\\r\\n* At least one change applies to this cmdlet. *\\r\\n* See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *\\r\\n**************************************************************************************************" | ||
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2025. *\\r\\n* At least one change applies to this cmdlet. *\\r\\n* See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *\\r\\n**************************************************************************************************" |
There was a problem hiding this comment.
The preview breaking-change banner now says Az v16.0.0 will be released in “May 2025”, which is already in the past and also conflicts with the changelog update to May 2026. Please correct the month/year in this preview message so users see an accurate breaking-change announcement date.
| set: | ||
| preview-announcement: | ||
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v15.0.0, to be released on November 19th 2025. *\\r\\n* At least one change applies to this cmdlet. *\\r\\n* See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *\\r\\n**************************************************************************************************" | ||
| preview-message: "*****************************************************************************************\\r\\n* This cmdlet will undergo a breaking change in Az v16.0.0, to be released on May 2025. *\\r\\n* At least one change applies to this cmdlet. *\\r\\n* See all possible breaking changes at https://go.microsoft.com/fwlink/?linkid=2333486 *\\r\\n**************************************************************************************************" |
There was a problem hiding this comment.
Same issue as above: this preview breaking-change banner states “May 2025”, which is in the past and conflicts with the intended May 2026 announcement. Please update the date in this message to match the actual planned breaking-change effective date.
| deprecated-by-azversion: 15.0.0 | ||
| change-effective-date: 2025/11/19 | ||
| deprecated-by-azversion: 16.0.0 | ||
| change-effective-date: 2025/05 |
There was a problem hiding this comment.
change-effective-date: 2025/05 is inconsistent with the other breaking-change entries updated to Az 16.0.0 and with the changelog note indicating May 2026. If the effective date moved to May 2026, update this value accordingly; otherwise, align the changelog and preview messages with the actual effective date.
| change-effective-date: 2025/05 | |
| change-effective-date: 2026/05 |
| Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Az.SecurityInsights", "..\..\generated\SecurityInsights\SecurityInsights.Autorest\Az.SecurityInsights.csproj", "{D620B181-286B-487D-8112-7AFB12BC48E0}" | ||
| EndProject |
There was a problem hiding this comment.
This PR is scoped to updating the breaking change announcement date, but this change updates the Az.SecurityInsights project GUID in the solution. Please confirm this GUID change is intentional; if it’s an accidental regeneration/noise, revert it to keep the PR focused and reduce downstream merge conflicts.
| --- | ||
| Module Name: Az.SecurityInsights | ||
| Module Guid: a632df01-f50e-49fb-b2de-e91a0090c840 | ||
| Module Guid: 8e31f664-41a6-46c6-ba93-5fc34733ec88 |
There was a problem hiding this comment.
This PR is about updating breaking-change announcement dates, but it also changes the Module Guid in the generated help metadata. Please confirm this GUID change is intentional (e.g., required by a regeneration pipeline); otherwise revert to avoid unrelated churn in documentation artifacts.
| @@ -1,3 +1,3 @@ | |||
| { | |||
| "generate_Id": "a062268b-a8f0-4e2a-a487-273786173c10" | |||
| "generate_Id": "5d560291-eed6-4aed-bee9-cd5c6119c97f" | |||
There was a problem hiding this comment.
This PR appears focused on a breaking-change date update, but it also changes the generator tracking ID. If this is not required for the date change (and was produced by an incidental regen), consider reverting to avoid unrelated diffs.
Description
Mandatory Checklist
Please choose the target release of Azure PowerShell. (⚠️ Target release is a different concept from API readiness. Please click below links for details.)
Check this box to confirm: I have read the Submitting Changes section of
CONTRIBUTING.mdand reviewed the following information:ChangeLog.mdfile(s) appropriatelysrc/{{SERVICE}}/{{SERVICE}}/ChangeLog.md.## Upcoming Releaseheader in the past tense.ChangeLog.mdif no new release is required, such as fixing test case only.